extends BaseSearchPage
Use this to do queries, optionally including aggregations and selecting terms Eg contentSearch?q=farm&aggregations=type/categories&term-type=News This will query for: query text = farm (will search in title, content) type = News (will look for a type field of exact value News) aggregations: first by type, then with a nested aggregation of categories
Properties
| Name | Returns | Notes | Example |
|---|---|---|---|
| hit | SearchResults | Deprecated, use the searchResults property insted | |
| searchResults | SearchResults | The search results, if any. Uses the following parameters: q=the query from=the number of the result to start from size=the size of results to use in pagination aggregations=the list of aggregrations to return, as comma seperated paths terms, in the form of term-category, term-tags, etc=selected terms to filter by | |
| parent | CommonCollectionResource |
Methods
| Name | Returns | Notes | Example |
|---|---|---|---|
| search ( query, from, size ) | SearchResults | ||
| search ( query, from, size, aggs, selTerms ) | SearchResults | ||
| search ( query, from, size, aggs, selTerms, excludedTerms ) | SearchResults | ||
| search ( config ) | SearchResults | ||
| prepareSearch ( query ) | SearchConfig | Use this with the search(config) method as a (possibly) more convenient way of executing search with a complex set of options Eg $page.search( $page.prepareSearch("hello world").exclude("module") ) |
Ask a question, or offer an answer